Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Full Changesets usage to automate releases #174

Merged
merged 5 commits into from
Feb 21, 2024
Merged

Full Changesets usage to automate releases #174

merged 5 commits into from
Feb 21, 2024

Conversation

leordev
Copy link
Member

@leordev leordev commented Feb 14, 2024 •
edited
Loading

Completes the release pipeline which fully uses Changesets to publish to NPM, create git tags and releases with proper changelog notes.

Working evidences in a forked repo:

I've also updated the README release section.

Also, if there are any present changesets on main we are automatically publishing a preview release using the next tag.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Feb 14, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 1c69cca

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov Codecov
Copy link

codecov bot commented Feb 14, 2024 •
edited
Loading

Codecov Report

Merging #174 (1c69cca) into main (ffc3af8) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #174   +/-   ##
=======================================
  Coverage   92.52%   92.52%           
=======================================
  Files          37       37           
  Lines        3011     3011           
  Branches      326      326           
=======================================
  Hits         2786     2786           
  Misses        225      225
Components Coverage Δ
protocol 93.46% <ø> (ø)
http-client 93.63% <ø> (ø)
http-server 89.49% <ø> (ø)

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 14, 2024 •
edited
Loading

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 12

@tbdex/protocol

  • Project entry file: packages/protocol/src/main.ts

@tbdex/http-client

  • Project entry file: packages/http-client/src/main.ts
📄 File: packages/http-client/src/errors/request-error.ts
⚠️ extractor:ae-missing-release-tag: "RequestErrorParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L1
⚠️ extractor:ae-undocumented: Missing documentation for "RequestErrorParams". #L1
⚠️ extractor:ae-undocumented: Missing documentation for "recipientDid". #L13
⚠️ extractor:ae-undocumented: Missing documentation for "url". #L14
📄 File: packages/http-client/src/errors/request-token-error.ts
⚠️ extractor:ae-missing-release-tag: "RequestTokenErrorParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L3
⚠️ extractor:ae-undocumented: Missing documentation for "RequestTokenErrorParams". #L3
📄 File: packages/http-client/src/errors/response-error.ts
⚠️ extractor:ae-missing-release-tag: "ResponseErrorParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L3
⚠️ extractor:ae-undocumented: Missing documentation for "ResponseErrorParams". #L3
⚠️ extractor:ae-undocumented: Missing documentation for "statusCode". #L15
⚠️ extractor:ae-undocumented: Missing documentation for "details". #L16
⚠️ extractor:ae-undocumented: Missing documentation for "recipientDid". #L17
⚠️ extractor:ae-undocumented: Missing documentation for "url". #L18

@tbdex/http-server

  • Project entry file: packages/http-server/src/main.ts

TBDocs Report Updated at 2024-02-21T16:54:38Z 1c69cca

KendallWeihe
KendallWeihe reviewed Feb 15, 2024
View reviewed changes
README.md

When a changeset PR is merged to main we will automatically create a GitHub release using the workflow [Create GH Release](./.github/workflows/create-gh-release.yml).
Just merge the [Version Packages PR](https://github.com/TBD54566975/tbdex-js/pulls?q=is%3Apr+author%3Aapp%2Fgithub-actions+%22Version+Packages%22+) when you are ready to publish the new versions!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, this language is much better!

KendallWeihe
KendallWeihe reviewed Feb 15, 2024
View reviewed changes
package.json Outdated Show resolved Hide resolved
KendallWeihe
KendallWeihe reviewed Feb 15, 2024
View reviewed changes
.github/workflows/release.yml
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Publish `next` preview
Copy link
Contributor

@KendallWeihe KendallWeihe Feb 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so what does this do exactly? it publishes a package with version equal to next?

what is this checking for (line below) steps.changesets.outputs.pullRequestNumber != ''

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, didn't read the full description, my bad

"Also, if there are any present changesets on main we are automatically publishing a preview release using the next tag."

excellent!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Leaving this unresolved for awareness!

KendallWeihe
KendallWeihe reviewed Feb 15, 2024
View reviewed changes
package.json Outdated Show resolved Hide resolved
KendallWeihe
KendallWeihe approved these changes Feb 15, 2024
View reviewed changes
Copy link
Contributor

@KendallWeihe KendallWeihe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very cool!

one comment about dev dependencies, but lgtm! ✅

@leordev leordev force-pushed the leordev/automate-changesets-releases branch from fb5d407 to 1c69cca Compare February 21, 2024 16:53
@leordev leordev merged commit f4ef4af into main Feb 21, 2024
16 of 17 checks passed
@leordev leordev deleted the leordev/automate-changesets-releases branch February 21, 2024 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KendallWeihe KendallWeihe KendallWeihe approved these changes

@jiyoontbd jiyoontbd jiyoontbd approved these changes

@michaelneale michaelneale Awaiting requested review from michaelneale michaelneale is a code owner

@mistermoe mistermoe Awaiting requested review from mistermoe mistermoe is a code owner

@phoebe-lew phoebe-lew Awaiting requested review from phoebe-lew

@kirahsapong kirahsapong Awaiting requested review from kirahsapong kirahsapong is a code owner

@diehuxx diehuxx Awaiting requested review from diehuxx diehuxx is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@leordev @KendallWeihe @jiyoontbd